/*
 * Middleware
 * Copyright (C) 2010/11
 * Riccardo Pulvirenti, Giuseppe Ravidà, Andrea Tino
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANDABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://www.gnu.org/licenses
 */

/*!
 * File: discovery.hpp
 */

#ifndef _DISCOVERY_HPP_
#define _DISCOVERY_HPP_

#include "interface.hpp"
#include "task_descriptor.hpp"
#include "worker_descriptor.hpp"
#include "address.hpp"

//-----------------------------------------------------------------------------
// Interface definitions
namespace middleware {
/*! \class Discovery
 * \brief Interface for Worker/WorkerDiscovery and Manager/WorkerDiscovery
 * communication.
 *
 * Interface for classes aiming to connect to WorkerDiscovery and
 * performing operations to communicate to it.
 */
interface Discovery {
public:
	/*!
	 * Used to invoke WorkerDiscovery in order to get a Worker's Address
	 * representing the best peer chosen to execute the specified
	 * TaskDescriptor.
	 * \param taskdesc TaskDescriptor to provide in order to get the most
	 * suitable peer (its Address) able to execute that task in the most
	 * possible efficient way.
	 * \return Returns the Address of the peer able to execute the provided
	 * TaskDescriptor.
	 */
	virtual Address get_worker(const TaskDescriptor& taskdesc) = 0;
	/*!
	 * Used to invoke WorkerDiscovery, usually from a Worker, in order to
	 * request the replacement of a specified WorkerDescriptor caused by
	 * that Worker to have changed its status.
	 * \param workerdesc WorkerDescriptor to replace.
	 */
	virtual void update_worker(const WorkerDescriptor& workerdesc) = 0;
};
} /* middleware */

#endif
